vcLayout

vcLayout represents simulation layout object, which may contain vcComponent and other vcLayouts.

See in: Overview

Module: vcCore

Parent: vcNode

Children: vcWorld

Referenced by: vcLayoutVisualization.Layout, vcWorld.Layouts

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
Behaviors	list	R	Behaviors in layouts are not supported. Returns: An empty list.
ChildLayouts	vcList[vcLayout]	R	Gets the direct child layouts of this layout.
ParentLayout	vcLayout	R	Gets the parent layout of this layout, if any.
Visualization	vcLayoutVisualization	R	Gets the layout specific visualization settings.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
clone	vcLayout	Optional Keyword[parent = vcLayout]	Creates a clone of sub-layout and its children structure in 3D world, and then returns the new sub-layout. See more Parameters: parent (vcLayout): Parameter is the parent sub-layout to be set to the new clone. If this parameter is empty, it will use the parent of the current cloning source, meaning that the source and clone will have the same parent. Returns: vcLayout: The cloned vcLayout situated at the new parent. Exceptions:' ValueError: When the layouts are the same. RuntimeError: Cloning of a sub-layout is not allowed when there is a hierarchy lock in the node tree, which happens during layout loading, or while moving a node from one place to another. RuntimeError: When there is no license for Layouts.
createBehavior	None	None	Layouts don't support behaviors. Exceptions: RuntimeError: Always.
createBehavior	None	None	-
createLayout	vcLayout	String name	Creates a new empty simulation layout under this node (vcLayout or a class inheriting vcLayout). See more Parameters: Name of the layout instance. Returns: The created layout node. RuntimeError: When there is no license for Layouts.
delete	None	None	Deletes layout node. See more Exceptions: RuntimeError: When there is no license for Modeling API. RuntimeError: When there is no license for Layouts.
getFeature	None	None	Features directly on a layout are not supported. Returns: None.
moveChildrenFrom	None	vcLayout source, Boolean globalpos	Moves all nodes inherited from vcNode (including vcLayouts) under one layout to another. See more Parameters: source (vcLayout): Moves the source layout’s children to this layout. globalPos (bool): If true or not set, the method overwrites the children’s relational / in reference transform with a new transform, which leaves them to their current global position. If set to false, their local transform is left untouched and their position changes accordingly to the new parent. Exceptions: RuntimeError: When either of the layouts are hierarchy locked. RuntimeError: When there is no license for Layouts.